Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: navigation delegation loops #1272

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

msmtamburro
Copy link
Contributor

@msmtamburro msmtamburro commented Nov 22, 2022

note: works around, rather than addresses existing architectural issues (#1030)
note: should be reviewed after merging this related PR #1050

Platforms affected

cordova-ios

Motivation and Context

This is related to #1030, in that I noticed the existing looping/reflection pattern in CDVWebViewEngine was copied, and I wanted to provide an example of how to allow consumers to explicitly be delegates, so that pattern, which crashes, does not make its way in to other pieces of code.

Description

The existing behavior, that CDVViewController can be a WKNavigationDelegate, was not obvious, so I documented it. While it would be more explicit to set the navigation delegate in the designated initializer (like is done with the WKWebViewConfiguration), I did not want to drastically change what's being done here. The existing behavior also loops through the plugins and uses reflection to see if any handle specific WKNavigationDelegate methods. The way this is done can crash (is crashing in my production app), as the list of plugins can change while this loop iterates.

What I did change:

  • When a consumer has bothered to extend CDVViewController to be a WKNavigationDelegate, I've disabled the looping
  • I cleaned up the looping to make it less likely to crash

Testing

I've tested the existing behavior:

  • Overriding does not disable looping
  • Looping does not appear to crash

I've tested the new behavior:

  • Looping is disabled when overriding (making CDVViewController a WKNavigationDelegate)

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

msmtamburro and others added 14 commits December 11, 2020 14:11
… note: works around, rather than addresses existing architectural issues (apache#1031)
* issue_900_websiteDataStore:
  fix: update the existing tests of the default behavior
  feat: add CDVWebViewEngineConfigurationDelegate to fully expose WKWebView configuration (apache#900)

# Conflicts:
#	CordovaLib/Classes/Private/Plugins/CDVWebViewEngine/CDVWebViewEngine.m
* issue_900_websiteDataStore:
  chore: bring back initWithFrame, as existing CDVWebViewEngineProtocol conforming plugins use it
…iewWithFrame

chore: clean up newCordovaViewWithFrame in order to extract initializ…
* issue_900_websiteDataStore:
  chore: clean up newCordovaViewWithFrame in order to extract initialization with configuration
@msmtamburro
Copy link
Contributor Author

Thanks for your patience; I've re-raised this PR now that I've gotten access at work again.

@msmtamburro
Copy link
Contributor Author

Issue with the codecov.io setup?
{'detail': ErrorDetail(string='Missing "owner" argument. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}

@breautek
Copy link
Contributor

I'll rerun the test, I think that happens intermediately sometimes.

@msmtamburro
Copy link
Contributor Author

Before I lose access again (through work), this one seems like it is good to go.

@breautek breautek closed this Feb 22, 2024
@breautek breautek reopened this Feb 22, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.25%. Comparing base (6e93ee9) to head (e1d8a81).
Report is 38 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1272      +/-   ##
==========================================
- Coverage   78.26%   78.25%   -0.02%     
==========================================
  Files          15       15              
  Lines        1767     1789      +22     
==========================================
+ Hits         1383     1400      +17     
- Misses        384      389       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@breautek breautek changed the title Issue 1031 delegates fix: navigation delegation loops Feb 22, 2024
dpogue added a commit to dpogue/cordova-ios that referenced this pull request Aug 26, 2024
We don't rely on the protocol itself being implemented by the plugins
(we continue to check with `-respondsToSelector:`) but this allows us to
avoid `objc_msgSend` and provides a way to document some of this plugin
behaviour that is not otherwise explained.

This should also resolve the unsafe plugin iteration issue that was
mentioned in apacheGH-1272 and apacheGH-1030 by always iterating over an array of
plugin objects that is a copy (due to calling `-allValues`).
dpogue added a commit that referenced this pull request Aug 28, 2024
We don't rely on the protocol itself being implemented by the plugins
(we continue to check with `-respondsToSelector:`) but this allows us to
avoid `objc_msgSend` and provides a way to document some of this plugin
behaviour that is not otherwise explained.

This should also resolve the unsafe plugin iteration issue that was
mentioned in GH-1272 and GH-1030 by always iterating over an array of
plugin objects that is a copy (due to calling `-allValues`).
@dpogue
Copy link
Member

dpogue commented Aug 28, 2024

Handled the loop issue slightly differently in #1479 but with the same idea of creating a copy of the map before iterating over the plugins. Also added synchronization to help ensure that we're not adding plugins while generating the copy of the values.

Thanks for clearly explaining the problem!

I intend to review the navigation policy stuff (in the context of additions like #1333) and will try to bring those changes in.

@dpogue dpogue added this to the 8.0.0 milestone Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants